Repository navigation
Clarify required and optional TRX report metadata - #56891
Merged
Evangelink merged 1 commit intoNov 13, 2026
Merged
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
The precise MTP 2.5.1 and TRX runtime guarantees need framework-maintainer validation because access restrictions prevented verification against the relevant TestFx source and issues.
No open issues 🎉
What changed in this PR
Clarifies the TRX data contract for test-framework authors in the Microsoft.Testing.Platform documentation. The changes distinguish required result data from optional report enrichment without changing reporter behavior.
Changes:
- Document required final-state and identity properties separately from optional metadata.
- Explain timing and name fallbacks, repeated-UID consistency, property containers, and capability warnings.
- Link the reporting and framework guides to the requirements while preserving existing examples and the TRX anchor.
| File | Description |
|---|---|
| docs/core/testing/microsoft-testing-platform-test-reports.md | Adds identity requirements and links to required and optional data guidance. |
| docs/core/testing/microsoft-testing-platform-architecture-test-framework.md | Directs framework authors to required identity data on final node updates. |
| docs/core/testing/microsoft-testing-platform-architecture-capabilities.md | Details TRX requirements, optional enrichment, fallbacks, and consistency rules. |
Review effort: Balanced
Evangelink
enabled auto-merge (squash)
November 13, 2026 13:43
azat-msft
approved these changes
Nov 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Framework authors need to know which test-node data TRX requires and which properties only enrich the report. The existing guidance omits required identity data and overstates the fallback when a framework doesn't advertise TRX support.
The guidance reflects the reviewed TestFx implementation and verified Microsoft.Testing.Platform 2.5.1 behavior. This PR changes documentation only.
Relates to microsoft/testfx#12436.
Internal previews
Build report